home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / g.arc / G.DOC next >
Text File  |  1989-10-04  |  9KB  |  240 lines
  1.                        G - Directory Nickname Utility
  2.                ==============================
  3.  
  4.  
  5. NAME
  6.     G - Go to directory...
  7.  
  8.  
  9. SYNOPSIS
  10.  
  11.     G                             - current directory
  12.     G nickname                    - go to directory
  13.     G -l [nickname]               - list nicknames file (unsorted)
  14.     G -n                          - list sorted by nickname
  15.     G -p                          - list sorted by path
  16.     G -a nickname [path]          - add a nickname to nicknames file
  17.     G -d nickname                 - delete a nickname from the file
  18.     G -r nickname1 nickname2      - rename a nickname
  19.     G -f [path]                   - find nickname for a path
  20.     G -c                          - clean up the nicknames file
  21.     G -s                          - statistics on the nicknames file
  22.     G -i                          - info
  23.     G -?                          - help
  24.  
  25.  
  26. INTRODUCTION
  27.  
  28.     G allows you to give nicknames to your favourite directories.  
  29.  
  30.     G keeps a file of nicknames and associated paths and allows you to change
  31.     directories by using the nickname instead of the path.
  32.     This can be really handy for frequently used directories or long path
  33.     names.
  34.  
  35.     G has all the functionality of the DOS cd or chdir command and can be used
  36.     as an enhancement or replacement for cd.
  37.  
  38.     G has a complete set of command switches for maintaining the nicknames
  39.     file.  They include List, Add, Delete, Rename, Find and Cleanup, as well
  40.     as the ability to show the current directory.
  41.  
  42.     G is able to change drives as well.  So you may use G to save keystrokes
  43.     when you want to go to a path on another drive.  This is handy for use on
  44.     a network where you may have many drives accessable.
  45.  
  46.     G uses an environment variable to decide where its file of nicknames is
  47.     kept.  You therefore can have multiple nickname files by simply changing
  48.     the contents of the environment variable.
  49.  
  50.     G keeps the previous directory name in nickname 'back', you can always 
  51.     return to where you where easily.
  52.  
  53.     G sets the ERRORLEVEL on exit to 0 if successful or 1 if not.  Can be 
  54.     used in batch files to control batch execution.
  55.  
  56.  
  57. USAGE
  58.  
  59.     G
  60.         - Used alone G reports the current directory.
  61.  
  62.     G -?
  63.         - Help with G's command line switches.
  64.  
  65.     G nickname
  66.         - Change the current directory, G searches for the directory to change
  67.           to in 3 ways:
  68.             1 - Use 'nickname' as an explicit path, try to cd to it.
  69.                 This is exactly like typing 'cd nickname'.            
  70.             2 - Search the nicknames file for 'nickname'.
  71.                 If found try to cd to the associated path.
  72.             3 - Search the DOS environment for 'nickname'.
  73.                 If found use the environment string as a path to cd to.
  74.         - G searches for 'nickname' in this order, when it is successful in
  75.           changing the directory it stops searching.
  76.  
  77.     G -l [nickname]
  78.         - List the nicknames file with the paths. If 'nickname'is given G
  79.           searches for the nickname given only.
  80.  
  81.     G -n
  82.         - List nicknames file sorted by nickname.
  83.  
  84.     G -p
  85.         - List nicknames file sorted by path.
  86.     
  87.     G -a nickname [path]
  88.         - Add 'nickname' to the nicknames file.  If 'path' is given it will be
  89.           associated with 'nickname'.  If no path is given G will use the
  90.           current directory as the path to associate with the nickname.
  91.  
  92.     G -d nickname
  93.         - Delete 'nickname' from the nicknames file.
  94.  
  95.     G -r nickname1 nickname2
  96.         - Rename 'nickname1' to 'nickname2'.
  97.  
  98.     G -f [path]
  99.         - Find all entries in the nicknames file where 'path' matches the
  100.           nickname path.  If 'path' is not given G use the current directory
  101.           as the path to find.
  102.  
  103.     G -c
  104.         - G will go into "clean-up" mode, for each entry in the nicknames file
  105.           the user is asked if he wishes to keep the nickname.  The user is
  106.           prompted: "Keep? Yes/No/Save/Quit".  No means dump the nickname,
  107.           Save will save immediately, Quit will abort the clean-up.
  108.  
  109.     G -s
  110.         - Statistics on number of nicknames and 'unused' entry spots in the
  111.           nicknames file.
  112.  
  113.     G -i
  114.         - Information about G, who wrote it and why!!!
  115.  
  116.  
  117. NOTES
  118.  
  119.     G uses environment variable GPATHS to find the nicknames file.
  120.         -ie. SET GPATHS=c:\sys\names.g
  121.  
  122.     If GPATHS is not specified the file is called 'names.g' and is placed in
  123.     the root directory.  If you like you can use multiple nickname files by
  124.     changing the GPATHS environment variable.
  125.  
  126.     The previous directory is always available in nickname 'back' or 'b'
  127.         -ie. type 'G b' to go back to previous path.
  128.  
  129.     Drive letters can be included in a path, allowing you to change drives and
  130.     directories in one command.
  131.         -ie. G will change drives if the path associated with the nickname
  132.          given requires it.
  133.  
  134.     On exit the ERRORLEVEL is set to 0 if successful or 1 if not.  For use in
  135.     batch files to check if a directory change was successful.
  136.  
  137.         
  138.  
  139. EXAMPLES
  140.  
  141.     1. Short cut to a favourite directory.
  142.            Set up a nickname to your golf games directory by typing:
  143.                G -a golf c:\games\golf
  144.            
  145.            Change to your golf directory any time by typing:
  146.                G golf
  147.  
  148.            G will cd to 'c:\games\golf', changing drives if necessary.
  149.  
  150.     2. Save keystrokes in case of long pathnames.
  151.            Save your fingers by setting up a nickname for a long path:
  152.                G -a db c:\usr\src\lib\project\src\database
  153.  
  154.            Now G will cd to 'c:\usr\src\lib\project\src\database' with:
  155.            G db
  156.  
  157.     3. Temporarily save current directory path to return easily.
  158.            Set up the nickname 'sav' as the current directory:
  159.                G -a sav
  160.  
  161.            Return to the 'sav' directory any time by typing:
  162.                G sav
  163.  
  164.     4. Move around disks easily, eg. on your network.
  165.            You can change to a directory on another drive without the bother
  166.            of first having to change drives.
  167.  
  168.            To get to the games directory on your drive F: you have to type:
  169.                F:
  170.                cd \gamesdir
  171.  
  172.            With G you can combine the two commands into one:
  173.                G f:\gamesdir
  174.  
  175.            Set up a nickname for the games directory:
  176.                G -a fgames f:\gamesdir
  177.  
  178.            Now get to 'fgames' from any other drive with just one command:
  179.                G fgames
  180.        
  181.     5. Switch between two directories quickly using the 'back' nickname.
  182.            Flip back and forth between 'golf' and the current directory:
  183.                G golf
  184.                G back
  185.  
  186.         Go to 'golf' directory and flip back to where you where.  Nickname
  187.         'back' always contains the previous directory.  'Back' can even be
  188.         shortened to 'b', ie. 'G b' is the same as 'G back'.
  189.         
  190.     6. List your nicknames file.
  191.            List the nicknames, unsorted, by nickname or by pathname:
  192.                G -l
  193.                G -n
  194.                G -p
  195.  
  196.     7. Find out if a directory has a nickname.
  197.            Remind yourself of the nickname you've given to your golf:
  198.                G -f c:\games\golf
  199.  
  200.            See if there are any directories dedicated to games:
  201.                G -f games
  202.  
  203.            See if the current directory has a nickname:
  204.                G -f
  205.  
  206.     8. For power users, the DOS environment can also be used as a source of
  207.        G nicknames.
  208.            Temporarily set a nickname to a directory:
  209.                SET tmp=d:\temp
  210.                G tmp
  211.  
  212.            Programmers jump to INCLUDE and LIB directories using environment
  213.            variables:
  214.                G include
  215.                G lib
  216.  
  217.  
  218. AUTHORS
  219.  
  220.     James Duhault, Dean Ecclestone and Michael King.
  221.  
  222.     We wrote this little utility to use ourselves on our network and we now
  223.     find it nearly indespensible.  Try it for a while and you'll wonder why
  224.     DOS doesn't have G built-in.
  225.  
  226.     G - Go to directory...
  227.  
  228.         Shareware from DEK Utility Corp.
  229.         Copyright (C) 1989 by J. Duhault, D. Ecclestone & M. King
  230.     Not for sale or distribution except through Shareware sources.
  231.  
  232.         If you find 'G' to be of use please send $20 to
  233.             DEK Utility Corp.,
  234.             35 Denison Rd. W.,
  235.             Weston,
  236.             Ontario,
  237.             M9N 1B9
  238.  
  239.         You will be added to our Updates and New Products mailing list.
  240.